Security News
Fluent Assertions Faces Backlash After Abandoning Open Source Licensing
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Write a JSON file to disk, also creates intermediate directories in the destination path if they don't already exist.
Write a JSON file to disk, also creates intermediate directories in the destination path if they don't already exist.
Install with npm:
$ npm install --save write-json
var writeJson = require('write-json');
// async
writeJson('foo.json', {abc: 'xyz'}, function(err) {
// do stuff with err
});
// sync
writeJson.sync('foo.json', {abc: 'xyz'});
All methods support the same arguments as JSON.stringify (note that if you want to pass a replacer function to writeJson
- the main export, you must pass the replacer on an options object)
// async
writeJson('foo.json', {abc: 'xyz'}, null, 2, function(err) {
if (err) console.log(err);
});
// sync
writeJson.sync('foo.json', {abc: 'xyz'}, null, 2);
Or as an options object:
var options = {
replacer: function(key, value) {
// filter out properties
if (typeof value === 'string') {
return undefined;
}
return value;
},
space: 2
};
// async
writeJson('foo.json', {abc: 'xyz'}, options, function(err) {
if (err) console.log(err);
});
// sync
writeJson.sync('actual/test.json', expected, options);
Calls JSON.stringify
on the given value
then asynchronously writes the result to a file, replacing the file if it already exists and creating any intermediate directories if they don't already exist. Returns a promise if a callback function is not passed.
Params
filepath
{string}: Destination file pathvalue
{object}: Value to stringify.options
{object}: Options to pass to JSON.stringifycallback
{Function}: (optional) If no callback is provided, a promise is returned.returns
{undefined}Example
var writeJson = require('write');
var pkg = {name: 'write-json'};
writeJson('foo.json', pkg, function(err) {
if (err) console.log(err);
});
// pass options to JSON.stringify explicitly
writeJson('foo.json', pkg, null, 2, function(err) {
if (err) console.log(err);
});
// pass options to JSON.stringify as an object
// (since this method returns a promise if no callback is passed,
// if you want to pass a replacer function to JSON.stringify, it
// must be passed on an options object)
writeJson('foo.json', pkg, {
space: 2,
replacer: function(value) {
// filter out properties
if (typeof value === 'string') {
return undefined;
}
return value;
}
}, function(err) {
if (err) console.log(err);
});
The promise version of writeFile. Returns a promise.
Params
filepath
{String}: Destination file pathvalue
{any}: The value to stringifyoptions
{object}: Options to pass to JSON.stringifyreturns
{Promise}Example
var writeJson = require('write');
writeJson.promise('package.json', {name: 'write-json'})
.then(function() {
// do stuff
});
The synchronous version of writeFile. Returns undefined.
Params
filepath
{String}: Destination file pathvalue
{any}: The value to stringifyoptions
{object}: Options to pass to JSON.stringifyreturns
{undefined}Example
var writeJson = require('write');
writeJson.sync('package.json', {name: 'write-json'});
The stream version of writeFile. Returns a new WriteStream object.
Params
filepath
{string|Buffer|integer}: filepath or file descriptor.options
{object}: Options to pass to mkdirp and [fs.createWriteStream][fs]{#fs_fs_createwritestream_path_options}returns
{Stream}: Returns a new WriteStream object. (See Writable Stream).Example
var fs = require('fs');
var writeJson = require('write');
fs.createReadStream('defaults.json')
.pipe(writeJson.stream('package.json'))
.on('close', function() {
// do stuff
});
Changed
Added
Fixed
JSON.stringify
receives all intended argumentsPull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 11, 2017.
FAQs
Write a JSON file to disk, also creates intermediate directories in the destination path if they don't already exist.
The npm package write-json receives a total of 34,233 weekly downloads. As such, write-json popularity was classified as popular.
We found that write-json demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.